Add Company
The Add Company API facilitates the onboarding of Company onto the VisaB2B Connect platform. All relevant company details are captured through this API, mapping unique details with the company name.
Method: POST
{{URL}}/jsonrpc
Headers
Name | Value |
---|---|
Content-Type | application/json |
Example
Payload Parameters
Parameter | Description |
---|---|
id Mandatory | String Unique ID of request Example – "1" |
method Mandatory | String Method Name Example – "VisaService.AddCompany" |
params Mandatory | Object |
api Mandatory | Object |
credential Mandatory | String API credential provided by NetXD Example – "Basic cy5wYXJhbWVzd2FyYW4rMkBiYW5rY2J3Lm9yZzpUZXN0QDEyMzQ=" |
signature Mandatory | String Signature of the digitally signed payload Example – "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA==" |
payload Mandatory | Object |
company Mandatory | Object |
dailyVolume Optional | String Maximum limit of transaction amount per day Example – "9999999" |
singleTransaction Optional | String Maximum limit of transaction amount per transaction Example – "25000" |
ownershipDetails Mandatory | Array |
isIndividual Optional | Boolean Specifying whether customer is an individual or a company Example – false |
entityName Optional | String Name of the company Example – "saran" |
address Optional | String Address of the company Example – "chennai" |
countryOfBusinessRegistrationISO Optional | Number ISO code of business registered country Example – 840 |
firstName Optional | Null First name of individual Example – null |
lastName Optional | Null Last name of individual Example – null |
countryOfResidenceISO Optional | Null ISO code of residing country Example – null |
nationalityCountryCodeISO Optional | Null ISO code of nationality country Example – null |
orgName Mandatory | String Organization name of the company Example – "TEST12" |
emailId Optional | String Email Id of the company Example – "saran.k@gmail.com" |
accountNumber Mandatory | String Bank Account number of the company Example – "123456789789412" |
routingNumber Optional | String Bank's Routing number Example – "1122" |
defaultCurrencyIsoCode Mandatory | String ISO code for default currency Example – "840" |
businessRegistrationNumber Mandatory | String Registration number of the business/company Example – "121" |
taxId Mandatory | String Tax Id of the company Example – "TAXID7438543" |
clabe Optional | String unique identifier that is used to track and process banking transactions Example – "545" |
corporateLegalName Mandatory | String Legal name of the company Example – "saran12" |
industryCode Mandatory | String Industry code of the company Example – "01" |
address1 Mandatory | String Company address line 1 Example – "chennai" |
address2 Optional | String Company address line 2 Example – "chennai" |
unitNo Optional | String Unit number of the company Example – "897" |
city Optional | String City where the company is located Example – "chennai" |
state Optional | String State where the company is located Example – "TN" |
postalCode Optional | String Postal code of the company's location Example – "600028" |
countryIsoCode Mandatory | String Country ISO code where the company is located Example – "840" |
- cURL
- C#
- Go
- NodeJs
curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"id":"1","method":"VisaService.AddCompany","params":{"api":{"credential":"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5","signature":"MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="},"payload":{"company":{"dailyVolume":"9999999","singleTransaction":"25000","ownershipDetails":[{"isIndividual":false,"entityName":"saran","address":"chennai","countryOfBusinessRegistrationISO":840,"firstName":null,"lastName":null,"countryOfResidenceISO":null,"nationalityCountryCodeISO":null}],"orgName":"TEST12","emailId":"saran.k@gmail.com","accountNumber":"123456789789412","routingNumber":"1122","defaultCurrencyIsoCode":"840","businessRegistrationNumber":"121","taxId":"TAXID7438543","clabe":"545","corporateLegalName":"saran12","industryCode":"01","address1":"chennai","address2":"chennai","unitNo":"897","city":"chennai","state":"TN","postalCode":"600028","countryIsoCode":"840"}}}}'
var options = new RestClientOptions("{{URL}}/jsonrpc")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@" ""id"": ""1"",
" + "\n" +
@" ""method"": ""VisaService.AddCompany"",
" + "\n" +
@" ""params"": {
" + "\n" +
@" ""api"": {
" + "\n" +
@" ""credential"": ""Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5"",
" + "\n" +
@" ""signature"": ""MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA==""
" + "\n" +
@" },
" + "\n" +
@" ""payload"": {
" + "\n" +
@" ""company"": {
" + "\n" +
@" ""dailyVolume"": ""9999999"",
" + "\n" +
@" ""singleTransaction"": ""25000"",
" + "\n" +
@" ""ownershipDetails"": [
" + "\n" +
@" {
" + "\n" +
@" ""isIndividual"": false,
" + "\n" +
@" ""entityName"": ""saran"",
" + "\n" +
@" ""address"": ""chennai"",
" + "\n" +
@" ""countryOfBusinessRegistrationISO"": 840,
" + "\n" +
@" ""firstName"": null,
" + "\n" +
@" ""lastName"": null,
" + "\n" +
@" ""countryOfResidenceISO"": null,
" + "\n" +
@" ""nationalityCountryCodeISO"": null
" + "\n" +
@" }
" + "\n" +
@" ],
" + "\n" +
@" ""orgName"": ""TEST12"",
" + "\n" +
@" ""emailId"": ""saran.k@gmail.com"",
" + "\n" +
@" ""accountNumber"": ""123456789789412"",
" + "\n" +
@" ""routingNumber"": ""1122"",
" + "\n" +
@" ""defaultCurrencyIsoCode"": ""840"",
" + "\n" +
@" ""businessRegistrationNumber"": ""121"",
" + "\n" +
@" ""taxId"": ""TAXID7438543"",
" + "\n" +
@" ""clabe"": ""545"",
" + "\n" +
@" ""corporateLegalName"": ""saran12"",
" + "\n" +
@" ""industryCode"": ""01"",
" + "\n" +
@" ""address1"": ""chennai"",
" + "\n" +
@" ""address2"": ""chennai"",
" + "\n" +
@" ""unitNo"": ""897"",
" + "\n" +
@" ""city"": ""chennai"",
" + "\n" +
@" ""state"": ""TN"",
" + "\n" +
@" ""postalCode"": ""600028"",
" + "\n" +
@" ""countryIsoCode"": ""840""
" + "\n" +
@" }
" + "\n" +
@" }
" + "\n" +
@" }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "{{URL}}/jsonrpc"
method := "POST"
payload := strings.NewReader(`{`+"
"+`
"id": "1",`+"
"+`
"method": "VisaService.AddCompany",`+"
"+`
"params": {`+"
"+`
"api": {`+"
"+`
"credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",`+"
"+`
"signature": "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="`+"
"+`
},`+"
"+`
"payload": {`+"
"+`
"company": {`+"
"+`
"dailyVolume": "9999999",`+"
"+`
"singleTransaction": "25000",`+"
"+`
"ownershipDetails": [`+"
"+`
{`+"
"+`
"isIndividual": false,`+"
"+`
"entityName": "saran",`+"
"+`
"address": "chennai",`+"
"+`
"countryOfBusinessRegistrationISO": 840,`+"
"+`
"firstName": null,`+"
"+`
"lastName": null,`+"
"+`
"countryOfResidenceISO": null,`+"
"+`
"nationalityCountryCodeISO": null`+"
"+`
}`+"
"+`
],`+"
"+`
"orgName": "TEST12",`+"
"+`
"emailId": "saran.k@gmail.com",`+"
"+`
"accountNumber": "123456789789412",`+"
"+`
"routingNumber": "1122",`+"
"+`
"defaultCurrencyIsoCode": "840",`+"
"+`
"businessRegistrationNumber": "121",`+"
"+`
"taxId": "TAXID7438543",`+"
"+`
"clabe": "545",`+"
"+`
"corporateLegalName": "saran12",`+"
"+`
"industryCode": "01",`+"
"+`
"address1": "chennai",`+"
"+`
"address2": "chennai",`+"
"+`
"unitNo": "897",`+"
"+`
"city": "chennai",`+"
"+`
"state": "TN",`+"
"+`
"postalCode": "600028",`+"
"+`
"countryIsoCode": "840"`+"
"+`
}`+"
"+`
}`+"
"+`
}`+"
"+`
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'POST',
'hostname': '{{URL}}',
'path': '/jsonrpc',
'headers': {
'Content-Type': 'application/json'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"id": "1",
"method": "VisaService.AddCompany",
"params": {
"api": {
"credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
"signature": "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="
},
"payload": {
"company": {
"dailyVolume": "9999999",
"singleTransaction": "25000",
"ownershipDetails": [
{
"isIndividual": false,
"entityName": "saran",
"address": "chennai",
"countryOfBusinessRegistrationISO": 840,
"firstName": null,
"lastName": null,
"countryOfResidenceISO": null,
"nationalityCountryCodeISO": null
}
],
"orgName": "TEST12",
"emailId": "saran.k@gmail.com",
"accountNumber": "123456789789412",
"routingNumber": "1122",
"defaultCurrencyIsoCode": "840",
"businessRegistrationNumber": "121",
"taxId": "TAXID7438543",
"clabe": "545",
"corporateLegalName": "saran12",
"industryCode": "01",
"address1": "chennai",
"address2": "chennai",
"unitNo": "897",
"city": "chennai",
"state": "TN",
"postalCode": "600028",
"countryIsoCode": "840"
}
}
}
});
req.write(postData);
req.end();
Body
{
"id": "1",
"method": "VisaService.AddCompany",
"params": {
"api": {
"credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
"signature": "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="
},
"payload": {
"company": {
"dailyVolume": "9999999",
"singleTransaction": "25000",
"ownershipDetails": [
{
"isIndividual": false,
"entityName": "saran",
"address": "chennai",
"countryOfBusinessRegistrationISO": 840,
"firstName": null,
"lastName": null,
"countryOfResidenceISO": null,
"nationalityCountryCodeISO": null
}
],
"orgName": "TEST12",
"emailId": "saran.k@gmail.com",
"accountNumber": "123456789789412",
"routingNumber": "1122",
"defaultCurrencyIsoCode": "840",
"businessRegistrationNumber": "121",
"taxId": "TAXID7438543",
"clabe": "545",
"corporateLegalName": "saran12",
"industryCode": "01",
"address1": "chennai",
"address2": "chennai",
"unitNo": "897",
"city": "chennai",
"state": "TN",
"postalCode": "600028",
"countryIsoCode": "840"
}
}
}
}
Response: 200
Response Parameters
Parameter | Description |
---|---|
companyId | String Unique identifier of the company Example – "65e18aa0a5a5039e373ded6a" |
bankId | String Company's bank Id Example – "12345678" |
lastUpdated | String Date of the last updated information about the company Example – "03/01/2024" |
statusText | String Status of the company Example – "ACTIVE" |
blockedCorridors | Object |
blockedCountries | Array |
blockedDesc | String Description for blocking Example – "visaBlocked" |
isoCountryCode | Number ISO code of country where company is located Example – 4 |
countryCode | String Country code where company is located Example – "AFG" |
countryDisplayName | String Country name Example – "AFGHANISTAN" |
transactionLimits | Object |
customLimits | String True, if Custom limits applicable Example – true |
dailyVolume | String Maximum limit of transaction amount per day Example – "9999999" |
singleTransaction | String Maximum limit of transaction amount per transaction Example – "25000" |
companyProfile | Object |
bankAccountNumber | String Company's Bank Account Number Example – "123456789789412" |
defaultCurrencyIsoCode | String ISO code of currency Example –"357" |
doingBusinessAs | String Name of the company Example – "TEST12" |
businessRegistrationNumber | String Registration number of the business/company Example – "121" |
taxId | String Tax Id of the company Example – "TAXID7438543" |
enterpriseId | String Id of the enterprise Example – "V-USA-EUR-10080373-100000001-001" |
clabe | String unique identifier that is used to track and process banking transactions Example – "545" |
corporateLegalName | String Legal name of the company Example – "saran12" |
bankRoutingNumber | String Routing number of bank Example – "1122" |
industryCode | String Industry code of the company Example – "01" |
address | Object |
city | String City where the company is located Example – "chennai" |
unitNo | String Unit number of the company Example – "897" |
zipCode | String Postal code of the company's location Example – "600028" |
line1 | String Address line 1 Example – "chennai" |
countryIsoCode | Number ISO Code of the country where company is located Example – 840 |
state | String State where the company is located Example – "TN" |
remitReconcileProfile | Object |
remitProfile | Object |
frequency | String Reconciliation frequency Example – "Every day" |
String Email Id of the company Example – "saran.k@gmail.com" | |
attachmentFormat | String Reconciliation file format Example – "PDF" |
deliveryMethod | String Reconciliation file delivery method Example – "email" |
reconcileProfile | Object |
frequency | String Reconciliation frequency Example – "Every day" |
String Email Id of the company Example – "saran.k@gmail.com" | |
attachmentFormat | String Reconciliation file format Example – "PDF" |
deliveryMethod | String Reconciliation file delivery method Example – "email" |
ownershipDetails | Array |
entityName | String Name of the company Example – "saran" |
address | String Address of the company Example – "chennai" |
isIndividual | Boolean Specifying whether customer is an individual or a company Example – false |
countryOfBusinessRegistrationISO | Number ISO code of business registered country Example – 840 |
{
"companyId": "65e18aa0a5a5039e373ded6a",
"bankId": "12345678",
"lastUpdated": "03/01/2024",
"statusText": "ACTIVE",
"blockedCorridors": {
"blockedCountries": [
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 4,
"countryCode": "AFG",
"countryDisplayName": "AFGHANISTAN"
},
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 8,
"countryCode": "ALB",
"countryDisplayName": "ALBANIA"
},
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 16,
"countryCode": "ASM",
"countryDisplayName": "AMERICAN SAMOA"
},
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 40,
"countryCode": "AUT",
"countryDisplayName": "AUSTRIA"
},
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 16,
"countryCode": "BRB",
"countryDisplayName": "BARBADOS"
},
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 248,
"countryCode": "ALA",
"countryDisplayName": "ALAND ISLANDS"
},
{
"blockedDesc": "visaBlocked",
"isoCountryCode": 533,
"countryCode": "ABW",
"countryDisplayName": "ARUBA"
}
]
},
"transactionLimits": {
"customLimits": true,
"dailyVolume": "9999999",
"singleTransaction": "25000"
},
"companyProfile": {
"bankAccountNumber": "123456789789412",
"defaultCurrencyIsoCode": "357",
"doingBusinessAs": "TEST12",
"businessRegistrationNumber": "121",
"taxId": "TAXID7438543",
"enterpriseId": "V-USA-EUR-10080373-100000001-001",
"clabe": "545",
"corporateLegalName": "saran12",
"bankRoutingNumber": "1122",
"industryCode": "01",
"address": {
"city": "chennai",
"unitNo": "897",
"zipCode": "600028",
"line1": "chennai",
"countryIsoCode": 840,
"state": "TN"
},
"remitReconcileProfile": {
"remitProfile": {
"frequency": "Every day",
"email": "saran.k@gmail.com",
"attachmentFormat": "PDF",
"deliveryMethod": "email"
},
"reconcileProfile": {
"frequency": "Every day",
"email": "saran.k@gmail.com",
"attachmentFormat": "PDF",
"deliveryMethod": "email"
}
},
"ownershipDetails": [
{
"entityName": "saran",
"address": "chennai",
"isIndividual": false,
"countryOfBusinessRegistrationISO": 840
}
]
}
}